ConsoleProtocol: Update Signatures to match ConsoleExpectMixin #1712
+9
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SmithChart
force-pushed
the
consoleprotocol-signatures
branch
from
c94eb6c to
e4b9c94
Compare
jluebbe
reviewed
Aug 5, 2025
labgrid/protocol/consoleprotocol.py
Outdated
| @@ -1,11 +1,14 @@ | |||
| import abc | |||
| from typing import Optional | |||
|
|
|||
| from pexpext import EOF, TIMEOUT | |||
There was a problem hiding this comment.
This seems to be a typo breaking the CI?
Suggested change
| from pexpext import EOF, TIMEOUT | |
| from pexpect import EOF, TIMEOUT |
The ConsoleExpectMixin has learned some new tricks over time. But the ConsoleProtocol was not updated accordingly. Every class implementing the ConsoleProtocol also uses the ConsoleExpectMixin - so it's safe to update the signatures according to the ConsoleExpectMixin. For ConsoleProtocol.expect() I've used the type definition of the underlying pexpect library. I have not updated the return types, since it's not clear to me what the ConsoleExpectMixin should return. Signed-off-by: Chris Fiege <[email protected]>
SmithChart
force-pushed
the
consoleprotocol-signatures
branch
from
e4b9c94 to
30b1cc3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The ConsoleExpectMixin has learned some new tricks over time. But the ConsoleProtocol was not updated accordingly.
Every class implementing the ConsoleProtocol also uses the ConsoleExpectMixin - so it's safe to update the signatures according to the ConsoleExpectMixin.
For ConsoleProtocol.expect() I've used the type definition of the underlying pexpect library.
I have not updated the return types, since it's not clear to me what the ConsoleExpectMixin should return.
This helps users with IDEs to get better type hinting when using the ConsoleProtocol.
Checklist